Refactor package #39
Merged
Refactor package #39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wkearn
requested changes
Jun 20, 2024
There was a problem hiding this comment.
Good work, @Teschl. I left one comment about some outdated documentation.
When I went to build the docs, I got some errors because my old _autosummary directory still had files from the older version. I guess make clean just cleans the _build directory. Do you know of a way to make sure that those _autosummary files also get deleted automatically? It's not a big deal, because I can always manually delete that directory. It's just a little annoying to have to remember to do that.
|
@wkearn I added 'clean' to the makefile, overwriting the Sphinx version. It now cleans |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I refactored the package, so the locations of different functions make more sense. The functions creating a
GridObjectare now inutils.py, and callingtopotoolbox.GridObject()will result in an emptyGridObject.I also changed the way autosummary is used, so the way the functions are listed reflects the way they are used. Instead of having
topotoolbox.utils.load_dem()in the documentation, it's nowtopotoolbox.load_dem()for example. The docstrings are now in the numpy format instead of the Google one, this keeps readability while insuring they are formatted right in the documentation.closes #34